home *** CD-ROM | disk | FTP | other *** search
/ Shareworld 9 / Shareworld 9 (Disk 1 of 2).adf / SW9a / SWSI / SWSonicInterrogator.docs / SWSonicInterrogator.docs
Encoding:
Text File  |  1998-04-20  |  11.5 KB  |  328 lines

  1.  
  2. (Note that these docs are for the previous version of SWSI.  See the docs
  3. within the program for v1.7 info - such as how to look at the pictures in
  4. the Gallery.)
  5.  
  6.  
  7.                ShareWorld Sonic Interrogator v1.06
  8.  
  9.           Released with issue 8 of ShareWorld, May 1997
  10.  
  11.          This program is copyright © Carl Read 1996, 1997
  12.  
  13.       The music `Tomorrow' is copyright © Mike Richmond 1997
  14.  
  15.       The Music `Chipchoon' is copyright © Mike Richmond 1997
  16.  
  17. SWSI is designed to run alongside the Amiga disk magazine ShareWorld. As
  18. well as playing the issue's music it also lets the user answer the
  19. ShareWorld Questionnaire while reading the mag, even if they autobooted
  20. it. Although designed for using while the mag is running, SWSI is a
  21. stand-alone program and can be run just like any other program. It was
  22. introduced with ShareWorld Six, released in April of 1996.
  23.  
  24.     This Documentation Reader
  25.  
  26. The text in these docs can be scrolled using the buttons in the bottom
  27. right of the window or by using the slider-bar on its right side. You
  28. can also scroll the text by clicking on it and, while holding the mouse
  29. button down, moving the pointer up or down. There are five speeds of
  30. scrolling from fast-up through stopped to fast down. The window can also
  31. be resized - with the text wrapping tidily. The Help button on the main
  32. SWSI window will bring up this window, as will choosing Help from the
  33. menus.
  34.  
  35.     The Music Player
  36.  
  37. Music will start playing when SWSI is first run and the program allows
  38. you to play with it using its various gadgets. These are all on SWSI's
  39. main window and are as follows...
  40.  
  41.     Volume Control
  42.  
  43. These three gadgets alter the volume of the music. They are the `left'
  44. and `right' buttons and the slider gadget situated to the right of the
  45. word `Volume'. Clicking on the buttons will increase or decrease the
  46. volume while the slider may be used to quickly set the volume to
  47. somewhere near where you want it.
  48.  
  49.     The Filter
  50.  
  51. The Amiga's low-pass audio filter may be turned off and on using the
  52. Filter cycling button. Note that what is said on the button is what will
  53. happen when you click on it and not the state the filter's currently in.
  54. So if it says `Filter On' then the filter is off and thus ready to be
  55. turned on. You know it makes sense... (Yes, I know, I should have used
  56. radio buttons - but this was a rushed job. Okay?)
  57.  
  58.     Stopping The Music
  59.  
  60. The cycling button that says either `Silence' or `Music' is for turning
  61. the music on and off. When it says `Silence' the music should be playing
  62. - with clicking on `Silence' turning it off. (Yes, it should have been
  63. radio buttons too.)
  64.  
  65.     The Music
  66.  
  67. Below the word `Music' is a box containing the modules you can listen
  68. to. The one selected will be highlighted. To choose another just click
  69. on its title.
  70.  
  71.     The Questionnaire Editor
  72.  
  73. The Questionnaire part of SWSI is for the readers of ShareWorld to give
  74. their opinion of the various contributions to the magazine, the results
  75. of which appear in the Feedback section of the magazine. For each
  76. article, picture or whatever a rating can given and, if you wish, some
  77. comments added as well. These can be saved to disk and when complete,
  78. sent to the editor who'll add them to the next issue's Feedback.
  79.  
  80. The following is a description of the various features of the
  81. Questionnaire Editor. (You will have to open up the window to see them
  82. all.)
  83.  
  84.     Name
  85.  
  86. Enter your name in the text-entry box to the right of the word `Name'.
  87. This is just so we can keep track of the various questionnaires returned
  88. and it WON'T appear in Feedback. If you want it made know that
  89. the comments are yours then say so at the end of each one.
  90.  
  91.     The Index Buttons
  92.  
  93. The `General', `Columns' etc. buttons mirror the Indexes in ShareWorld
  94. and are to let you quickly find the article you want to rate or to
  95. comment on.
  96.  
  97.     The Index Box
  98.  
  99. Below the Index Buttons is the Index itself where you can choose the
  100. contribution you want to rate or comment on. The buttons and slider on
  101. its right are for scrolling it. Also, just below the scrolling buttons
  102. are a left and right button for quickly moving back and forth through
  103. them.
  104.  
  105.     Colours
  106.  
  107. The twelve, coloured buttons to the right of the word `Colours' are for
  108. choosing the text and background colour of the text-editing box and the
  109. Help window.
  110.  
  111.     `*' `!' `?' `c'  Making Your Opinion Felt
  112.  
  113. The four buttons at the top-left of the text-editing box are for you to
  114. give a rating to the contribution you've selected. It's a three-star
  115. system and the four buttons mean the following...
  116.  
  117.  *   Not bad.
  118.  
  119.  **  Very good.
  120.  
  121.  *** Awesome! More, more, MORE please!
  122.  
  123.  ?   You didn't understand it.
  124.  
  125.  !   You thought it was crap.
  126.  
  127.  c   Clears the rating should you get it wrong.
  128.  
  129. Just click on these for each contribution, (after you've selected them
  130. from the Index), and the results will appear just above the buttons.
  131.  
  132.     Comments
  133.  
  134. Should you have any comments on a contribution, after selecting it from
  135. the Index, type them into the text-entry box at the bottom of the
  136. window. Keep your comments as short as possible and don't waste space by
  137. just putting into words what you've indicated by whatever you gave as. a
  138. rating. Feedback is a big enough file as it is!
  139.  
  140. The text-editor is a pretty standard affair (I hope) and has the
  141. following features...
  142.  
  143. Word-wrap: No need to press Return at the end of every line -
  144. just at the end of each paragraph. It also tidies itself up should you
  145. re-size its window.
  146.  
  147. Cursor controls: The cursors work as expected, (hopefully), and
  148. when used with shift will move to the top, bottom, left or right of your
  149. comments.
  150.  
  151. Delete: A window will appear if you use shifted delete which
  152. will offer you the choice of deleting all of your current comments. This
  153. will ONLY delete the comments you're currently writing - and
  154. not any you've written about other contributions.
  155.  
  156. Block Marking: Text can be marked using the mouse pointer in
  157. the standard way, letting you cut, copy, paste and delete you text.
  158.  
  159. And that's about it. After you've rated and commented on all the
  160. contributions you can be bothered with, save the completed Questionnaire
  161. to disk using `Save As' from the Project menu. (That's `Save As' -
  162. NOT `Save Comments' from the Comments menu.) You can also load
  163. them back in again so you don't have to fill it all in in the one
  164. sitting.
  165.  
  166.     The Menus
  167.  
  168. The three menus work in the standard Amiga way, meaning they can also be
  169. activated by pressing the right Amiga key and their keyboard equivilent
  170. - `Right Amiga O' for Open and so on.
  171.  
  172.     Project Menu
  173.  
  174.     New `N'
  175.  
  176. Erases everything you've entered. You'll be given the option of
  177. canceling.
  178.  
  179.     Open `O'
  180.  
  181. Opens a file requestor and allows you to load in a previously saved file
  182. containing Questionnaire data.
  183.  
  184.     Save `S'
  185.  
  186. Saves the Questionnaire data to disk without using a file requestor.
  187. However, a requestor will appear if you've not already saved or loaded
  188. the Questionnaire data since starting SWSI.
  189.  
  190.     Save As `A'
  191.  
  192. Opens a requestor and allows you to save the Questionnaire data to disk.
  193.  
  194.     About `?'
  195.  
  196. Opens a window giving you some info on this progam.
  197.  
  198.     Help `Help'
  199.  
  200. Opens a window, (meaning the window you're reading this in), which
  201. contains the documentation to this program - meaning these docs. Along
  202. with using the gadgets on the right of window to scroll through the
  203. docs, you can also click on the text in the window and while holding the
  204. mouse button down scroll the text up and down by moving the mouse up and
  205. down.
  206.  
  207.     Quit `Quit'
  208.  
  209. Exits the program. Make sure you've saved your Questionnaire results
  210. before you do this.
  211.  
  212.     Edit Menu
  213.  
  214.     Cut `X'
  215.  
  216. Cuts a marked block of text out of your comments and stores it so it may
  217. be pasted back in using `Paste'.
  218.  
  219.     Copy `C'
  220.  
  221. Copies a marked block of text from your comments and stores it so it may
  222. be pasted back in using `Paste'.
  223.  
  224.     Paste `V'
  225.  
  226. Pastes previously `Cut' or `Copied' text back into comments.
  227.  
  228.     Comments Menu
  229.  
  230.     Save Comments `M'
  231.  
  232. This opens a requestor and allows you to save the comments you've
  233. written to disk. This is so you can then turn them into an article if
  234. you think they're getting a bit long for the meant-to-be-brief
  235. Questionnaire comments. This only saves the current comments that are
  236. displayed in the Comments' window and not all the comments you've so far
  237. entered.
  238.  
  239.     Delete Comments `D'
  240.  
  241. This deletes all of the currently displayed comments.
  242.  
  243.     Previous `<'
  244.  
  245. Moves you back a contribution - meaning up the menus.
  246.  
  247.     Next `>'
  248.  
  249. Moves you forward a contribution - meaning down the menus.
  250.  
  251.     Finally
  252.  
  253. Hopefully all this makes sense and the readers of ShareWorld use it - as
  254. it'll make the editor's job of compiling the next issue's Feedback a lot
  255. easier.
  256.  
  257. I fully expect this to be pretty bug-ridden - especially in the text-
  258. editor. It was a rushed job and hasn't had much testing. I also expect
  259. it to crash when memory is low as Blitz doesn't handle low-memory too
  260. well. However, if you're carefull you should be able to fill in
  261. a Questionnaire with it - so good luck.
  262.  
  263. Anyway, have fun, and any Questionaires you fill in should be sent to...
  264.  
  265.       Carl Read
  266.       CyberCraft
  267.      PO Box 14032
  268.        Mayfair
  269.     Hastings 4201
  270.      NEW ZEALAND
  271.  
  272.     SWSI History
  273.  
  274. 96.04.07 - v1.00: First version finished.
  275.  
  276. 96.04.12 - v1.01: Had a report from an A4000 owner saying the program
  277. was crashing on their machine. This made me wonder if the Blitz commands
  278. RGBRed (and so on) should be used in preference to Red (and so on) on
  279. AGA machines so I've added a test for this in the program to see what
  280. happens.
  281.  
  282. Also, while I was at it, I fixed a bug that was causing block-marking to
  283. write outside the text-box and another that was putting a cursor square
  284. in the Help window.
  285.  
  286. 96.04.19 -  v1.02. Figured out the real reason for the above `AGA
  287. machines' problem. I'd not been taking into account that using non-Topaz
  288. 8 fonts on 2+ Amiga Workbenchs causes a change in the window-bar size,
  289. which alters the reading of the mouse x,y positions.
  290.  
  291. So I've altered that using WTopOff and, just to be sure, WLeftOff too.
  292. It would've been nice if you'd told us what those functions were for
  293. Acid... Oh, and I removed the `Check for AGA machine' routine as it is
  294. just possible that there's a few non-AGA Amigas out there with wb3 and
  295. 020s or better.
  296.  
  297. 96.10.08 - v1.03: This is the version released with ShareWorld 7. Fixed
  298. a bug in the article window which was leaving previous article titles
  299. there if less than five articles were in the section. Where were the
  300. columns this issue, people?!?
  301.  
  302. Removed the `joke' save response when users forgot to include their
  303. names. May have found the bug that was causing some to have trouble with
  304. the save routine too.
  305.  
  306. And I've found and fixed the bug that was causing the text to get
  307. screwed up - hurrah! Text entry's still not perfect and I haven't even
  308. tried to stop the flashing when delete is used, but I think text will
  309. now stay as it was typed. I think...
  310.  
  311. Oh yes, and I've added the all-important dots to the menus. Nothing's
  312. too much trouble to keep Mike Richmond happy.
  313.  
  314. 96.10.10 - v1.04: Noticed a bug on the day of SW7's release! And after a
  315. few copies had gone out. Anyway, it no longer crashes now if you click
  316. on the text slider when there's not enough text in the window to slide.
  317. Also fixed up another little glitch which was giving the cursor a letter
  318. when you used the shift-cursor-right key combination to go to the end of
  319. a line.
  320.  
  321. 96.10.23 - v1.05: Oops! You couldn't save a Questionnaire after loading
  322. in a previously saved one. Well, now you can. Thanks for pointing this
  323. out Mike. (:
  324.  
  325. 97.05.24 - v1.06: Altered a few minor things of no importance.
  326.  
  327.  
  328.